Skip to content

Sync API docs with the narrowed return types#26

Merged
delacry merged 1 commit into
0.1.xfrom
docs-sync
Jul 25, 2026
Merged

Sync API docs with the narrowed return types#26
delacry merged 1 commit into
0.1.xfrom
docs-sync

Conversation

@delacry

@delacry delacry commented Jul 25, 2026

Copy link
Copy Markdown
Member

Update the API reference for narrowing that landed in #15, #17, #18, #19, #21 and #22: flatten(), filterNotNull(), Map::filterValuesNotNull(), countWhere(), Collection::sum() and Map::toArray().

Compact types are inlined in the signature (countWhere(): int<0, max>); conditional ones are described in prose instead, matching how sum() and intersect() are already documented.

Also fix the flatten() assertion in TransformTypeTest, which still expected Collection and has failed on 0.1.x since #21.

@codecov

codecov Bot commented Jul 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@delacry
delacry merged commit 4e90318 into 0.1.x Jul 25, 2026
6 checks passed
@delacry
delacry deleted the docs-sync branch July 25, 2026 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant